Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update README #6

Merged
merged 1 commit into from
Aug 1, 2024
Merged

docs: update README #6

merged 1 commit into from
Aug 1, 2024

Conversation

NucciTheBoss
Copy link
Member

  • Add badge for build status of the documentation.
  • Update project and community links.
  • Add a cool emoji to the repo description.

I removed the Diátaxis and MyST related links because they are information that should be included in the CONTRIBUTING.md guidelines instead.

This is a test PR to ensure that the Read the Docs webhook that I set up is working correctly.

@NucciTheBoss
docs: update README
6194567 
- Add badge for build status of the documentation
- Update project and community links

Signed-off-by: Jason C. Nucciarone <[email protected]>
@NucciTheBoss NucciTheBoss added the enhancement New feature or request label Aug 1, 2024
@NucciTheBoss NucciTheBoss requested a review from jedel1043 August 1, 2024 15:53
jedel1043
jedel1043 approved these changes Aug 1, 2024
View reviewed changes
Copy link
Contributor

@jedel1043 jedel1043 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@NucciTheBoss NucciTheBoss merged commit 3d42a51 into charmed-hpc:main Aug 1, 2024
1 check passed
@NucciTheBoss NucciTheBoss deleted the update-readme branch August 2, 2024 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jedel1043 jedel1043 jedel1043 approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@NucciTheBoss @jedel1043